PolicyScreen

Element/Tag

Definition

Attribute

Element/Attribute Value and Description

<PolicyScreen>

The opening and closing tag of the business rule.

  <Fixed Fields>

Optional element;

This element allows the fixed fields to have the same configuration capabilities as dynamic ( below the line ) fields; the only exception being the ability to change the fixed field data types.

Note:  Only Issue State fixed field display can be changed.

    <Fields>

Required element;
Allows configuration of dynamic fields.

See Fields.

Note:  Icons for PolicySearchScreen and ClientSearchScreen can be configured in the PolicyScreen by using the policy and client datatype, which will be displayed as disabled text boxes with search and people icons, respectively. Searching returns the respective GUIDs.

<Buttons>

Optional element;
Allows configuration of buttons.

     <Button>

Optional element;
Defines the display of function buttons on the Policy screen.

Required Element value;
ButtonName
Allows the display of specified buttons on the Policy screen.

Note:  The Save button is the only button configured on the Policy screen.

<Events>

See Action Events

<SegmentsAllowed>

Optional element;
Specifies the number of segments that are allowed on the policy.

Required element value;
Integer / *
Number of segments. Allows the user to add only up to specified number of segments to the policy.

Note:  The star * symbol indicates that unlimited number of segments can be allowed for a policy.

<MinimumSegments>

Optional element;
Specifies the minimum number of segments that MUST be attached to a policy before any activity can be processed.

Optional element value;
Integer
Number of segments. This forces the user to add at least the minimum number of segments prior to processing the policy activities.

<DisablePolicyFields>

Optional element;
Specifies when fields on the Policy screen can or cannot be edited, based on policy status. Disables policy fields for the specified policy status if the policy status code matches a code in the DisabledStatus section for the particular policy.
 

Note:  When AutomaticPolicyNumber generator is not used, PolicyNumber field should be editable even after saving the policy that allows the entering and editing in that field until another policy event (calculating a coverage, issue of the policy).

       <DisabledStatus>

Required element;
Indicates which applicable status(es) would trigger the lock-down of editable fields. This element defines policy status codes for the policy fields that will be disabled on the Policy screen.

Required element value;
PolicyStatusCode
Policy Status Code from AsCode=>AsCodeStatus

       <SegmentCount>

Optional element;
This element specifies the segment count that will be used only when policy status does not match a code in the DisabledStatus section for the particular policy. When policy status does not match a code in the DisabledStatus section then policy fields will be disabled.

Optional element value;
_ * / + _
" * ": Disables policy fields in all conditions.
" + ": Disables policy fields when policy has at least a minimum of one segment in active status.

<AutomaticPolicyNumber>

Optional element;
Allows generating automatic policy number when a new policy is created as per the format specified in AutomaticPolicyNumber business rule.

Optional element value;
Yes:  Allows generating automatic policy number when new policy is created.

No: Automatic policy number will not be generated when new policy is created and allows the user to enter the policy number in to the PolicyNumber field.
 

<UseStateApproval>

Optional element;

Defines whether or not state approval is enforced.  This also controls the display of eligible states in IssueState drop down box.

Optional element value;

String: Yes/No

Yes:  State Approval is enforced for this policy and only eligible states will be displayed in the Issue State drop down box.

No:  Not State Approved, all states will be displayed in the Issue State drop down box.

If this element is not present default is "Yes".

<Roles>

Opening tag for defining roles on the policy.

ALWAYSEQUALPERCENT

Optional attribute;
Yes:  Allows equal percent for even and odd number of roles for a role type upon clicking the EqualPercent check box.
 

When Equal Percent check box is checked and the amounts aren't equal, the remaining amount is allocated to the last client

     <Role>

Required and repeatable element;
This element defines the description of the role that will be added to the policy.
Note:

• A role is a policy driven position held by a person or entity.

• Roles can be attached to the policy, when creating a new policy or attach to an existing policy.

• Each role tag will result in the addition of one or more clients to a specific role on a policy. By having multiple <Role> tags, more than one role can be added to a policy at the same time.

NAME

DISABLEPOLICYSTATUS

Optional attribute;
RoleName
A short description of the name as per AsCodeRole.

Optional Attribute;

PolicyStatusCode

Code as defined in AsCode=>AsCodeStatus.

Disables the role for the specified policy status, the disabled role will not be displayed in the Maintain Roles drop down box and Role check box will be disabled on Maintain Role screen.

Note:

If this element is not present Role will be displayed in Maintain drop down box and Role check box will be enabled on Maintain Roles screen.

      <RoleCode>

Required element;
Code values of a role that is applicable to this plan.

Required element value;
RoleCode
Role code of the role as per AsCodeRole.

      <RoleCount>

Optional element;
Specifies number of times a role can be assigned to policy.

Required element value;
Integer
Allows the user to assign this type of role only specified no of times to the policy.

       <RolePercent>

Optional element;
Defines the default role percent to be assigned to the role.

Required element value;
Integer
0-100 percent is a valid value.
Allows the specified role percent will be assigned as default percent to the role.

         <ClientType>

Optional element;
Define the client types that can be assigned to the role. Only these client types will be displayed in the Client Type dropdown box in the Client screen, for the specific role.

Example: An insured may need to be an individual client type for a particular plan.

Required element value;
ClientTypeCode
Client type code from AsCode table=>AsCodeClient.

   <Tests>

Optional Element;
Allows configuration of test(s) condition. The evaluation of the condition decides whether or not the particular role section can be executed.

       <Test>

Required/Repeatable Element;
Expression used to determine if role should be displayed/allowed for policy.

Expression;
Literal values can be used for the test condition.

   <AllowZeroPercent>

Optional element;

Allows Zero percent in Role percent fields.

Required element value;

Yes/No

Yes: Allows user to enter zero percent in the Role percent field.

No:  When set to "No" then Zero Percent is not allowed.

Note:

If this element is not present then the default is "Yes".

   <AllowNoPercent>

Optional element;

Controls the display of the Percent box next to the name of the individuals that have been assigned to the specified role.

Required element value;

Yes/No

Yes: Percentage box will not be listed next to the name of the individuals that has been assigned to the specified role.

No: When set to "No" Percentage box will be displayed next to name of the individual that has been assigned to the specified role.

Note:

If this tag is not present default is "No".

Table Name

Description

AsClient

Holds names of people and corporations/companies that can fill various roles related to policies.

AsCode

Stores a list of all OIPA codes and their related descriptions.

AsPolicy

Stores key data related to policies.

AsPolicyField

Stores field names and values related to policies.

AsRole

Defines the roles that clients can play relative to a policy.